home *** CD-ROM | disk | FTP | other *** search
/ Best of www.BestZips.com (Collector's Edition) / Best of WWW.BESTZIPS.COM Collector's Edition (JCSM Shareware) (JCS Marketing).ISO / help_sys / hlpgn131.zip / hlpgen.mac < prev    next >
Text File  |  1996-09-05  |  26KB  |  684 lines
  1. .rem(====================================)
  2. .rem(|   Macro File for HelpGen Help    |)
  3. .rem(|Copyright 1994-95 Rimrock Software|)
  4. .rem(|      All rights reserved.        |)
  5. .rem(====================================)
  6. .startc(main,Contents,HLPGEN.BMP,HelpGen Help,general,001)
  7. .top(Help)
  8. .top(Table of Contents)
  9. .n
  10. .b(Purpose) - Click on icon above.n.n
  11. .b(How to).n
  12. .in
  13. ##.j(lodmac,Load or Create a Macro file)
  14. ##.j(crehpj,Load or Create a Project File)
  15. ##.j(bldall,Build a Help File from a MAC File)
  16. ##.j(bldhtml,Build an HTML File from a MAC File)
  17. ##.j(lang,The HelpGen Macro Language)
  18. .un
  19. .n
  20. .j(mnucmd,Menu Commands).n
  21. .n
  22. .bmacro(Search,search.bmp)\tab.b(Search for Topic).n
  23. .n
  24. .bj(glossary,demo.bmp)\tab.b(Glossary).n
  25. .n
  26. If you are unfamiliar with how Windows Help works, choose
  27.  .b(Help | How To Use Help) from the Help menu now.
  28. .end
  29. .com(=================================)
  30. .com( Icon topic                      )
  31. .com(=================================)
  32. .ent(icon,Information,HelpGen ) \qc
  33. HelpGen version 1.30.  \'a9 1994-95 by Rimrock Software, all rights
  34.  reserved..n.n \ql
  35. Under normal circumstances, if you want to create a help file with
  36.  the Windows help compiler, you must first create a help topic file
  37.  using a word processor that can save files in Rich Text Format
  38.  (.p1(RTF)).  There are several basic problems with that approach:.n
  39. .in
  40. #n(1)Word processors cost a lot of money..n
  41. #n(2)Once you've purchased the word processor, you have to
  42.  learn how to use it.  This may not be a very productive use of
  43.  your programming time..n
  44. #n(3)You also have to learn how to use the word processor to
  45.  produce a file that is properly formatted for the help compiler.
  46.  This involves using items like underlining, double-underlining,
  47.  hidden text, footnotes, etc..n
  48. .un
  49. HelpGen eliminates these problems by allowing you to use your
  50.  favorite ASCII text editor to produce a HelpGen .p1(macro) file,
  51.  which HelpGen uses to create the RTF formatted file required by
  52.  the help compiler..n.n
  53. HelpGen automates the entire process of creating help files:.n
  54. .in
  55. ##Creates a skeleton macro file for you to edit.
  56. ##Invokes your editor to allow you to edit the macro file.
  57. ##Creates a help project file (.HPJ) to tell the help
  58.  compiler how to compile the help file.
  59. ##Generates an RTF file from the macro file.
  60. ##Invokes the help compiler to compile the RTF file into a
  61.  HLP file.
  62. ##Allows you to directly test the result..n
  63. .n
  64. .box
  65. The HelpGen macro engine is based on code written by David Spector,
  66.  and published in Windows/DOS Developer's Journal, Vol. 5, No. 7,
  67.  July 1994.
  68. .bend
  69. .n
  70. .rem(This version of HelpGen is a .p1(shareware) evaluation version.  You)
  71. .rem( may use this version for up to 60 days to determine whether the)
  72. .rem( program is of use to you.  If you continue to use the program)
  73. .rem( beyond that time period\'2c you must register.  Registration of)
  74. .rem( HelpGen is $30.)
  75. .end
  76. .com(=================================)
  77. .com( Load/Create macros topic        )
  78. .com(=================================)
  79. .entc(lodmac,Load/Create Macro File,How to ,general,010)
  80. Select the .b(File | Open Macro File) menu option.  Select an
  81.  existing .MAC file or enter the name of a new file.  If you enter
  82.  the name of a file that does not exist, HelpGen will create the
  83.  file for you, using a .p1(template) that contains the minimum items
  84.  required to build a help file..n
  85. .n
  86. If you have created a new .p1(macro) file, you should use the
  87.  .b(Edit | Macro File) option to make two changes to the file.  The
  88.  first change is a new title for the table of contents.  The default
  89.  title is xxxx.  The second change is the selection of a .BMP
  90.  graphic to place on the table of contents title line.  The default
  91.  is HlpGen.BMP.
  92. .end
  93. .com(=================================)
  94. .com( Load/Create project file topic  )
  95. .com(=================================)
  96. .entc(crehpj,Load/Create Project File,How to ,general,020)
  97. HelpGen looks for an associated .p1(project) file when you open the
  98.  current macro file.  If it finds one, HelpGen will enable the
  99.  .b(Edit | Project File) menu item, and you won't have to build a
  100.  project file.  If it doesn't find a project file, HelpGen will
  101.  enable the .b(Build | Project File) menu item to allow you to
  102.  create a project file.  You must select .b(Build | Project File) to
  103.  create the new project file..n
  104. .n
  105. .box
  106. .b(NOTE:) Before you build a project file, select the
  107.  .b(Options | Project File) menu item and make sure that all the
  108.  items in that dialog are to your liking.  Those items will be used
  109.  to create the project file.
  110. .bend
  111. .end
  112. .com(=================================)
  113. .com( how to build HLP from MAC       )
  114. .com(=================================)
  115. .entc(bldall,Build a HLP File From a MAC File,How to ,general,043)
  116. Select the .b(Build | HLP form MAC) menu item. HelpGen will create
  117.  a .RTF file by processing the .MAC file.
  118.  Macros will be expanded and .p(rtfcmds,RTF commands) and plain text
  119.  will be passed through to the .RTF file..n.n HelpGen then will invoke
  120.  the .p(hlpcmplr,help compiler) you have selected
  121.  in the .b(Options | Directories) menu item.  This will involve
  122.  shelling out to DOS, since help compilers are DOS programs.  When
  123.  HelpGen gets control again, it will enable the .b(Test) menu item,
  124.  to allow you to test the help file you have just created..n
  125. .n
  126. If there were errors generated during the help compilation, they
  127.  will be listed in the error log file that is shown in
  128.  .b(Options | Project File)..n
  129. .n
  130. .box
  131. .b(NOTE:) When HelpGen invokes the help compiler, and for some
  132.  reason the compiler can't execute, HelpGen will notify you by
  133.  displaying an error message.  To possibly correct your problem,
  134.  make sure that the proper help compiler is correctly chosen in
  135.  HelpGen's .b(Options | Directories) menu item.
  136. .bend
  137. .end
  138. .com(=================================)
  139. .com( how to build HTML from MAC      )
  140. .com(=================================)
  141. .entc(bldhtml,Build an HTML File From a MAC File,How to ,general,046)
  142. Select the .b(Build | HTML File) menu item. HelpGen will create a World
  143.  Wide Web .p1(HTML) page from the current .MAC file. The generated file will have
  144.  a .HTM file extension. You can test this file by selecting the
  145.  .b(Test | Test HTML File) menu item.
  146. .end
  147. .com(=================================)
  148. .com( using helpgen TOC topic         )
  149. .com(=================================)
  150. .entc(lang,Macro Language,The HelpGen ,general,050)
  151. .in
  152. ##.j(langbas,Macro Language Basics)
  153. ##.j(maccmd,Macro Language Commands)
  154. ##.j(rtfcmd,Useful RTF Commands)
  155. .un
  156. .end
  157. .com(=================================)
  158. .com( menu topic                      )
  159. .com(=================================)
  160. .entc(mnucmd,HelpGen Menu,The ,general,055)
  161. .in
  162. .bmp(mnu.shg).n
  163. .n
  164. Click on the menu item you want help with.
  165. .un
  166. .end
  167. .com(=================================)
  168. .com( file commands topic             )
  169. .com(=================================)
  170. .entc(file,File Commands,The ,general,060)
  171. .in
  172. .bmp(mnufil.shg).n
  173. .n
  174. Click on the menu item you want help with.
  175. .un
  176. .end
  177. .com(=================================)
  178. .com( edit commands TOC topic         )
  179. .com(=================================)
  180. .entc(edit,Edit Commands,The ,general,070)
  181. .in
  182. .bmp(mnuedt.shg).n
  183. .n
  184. Click on the menu item you want help with.
  185. .un
  186. .end
  187. .com(=================================)
  188. .com( build commands TOC topic        )
  189. .com(=================================)
  190. .entc(generate,Build Commands,The ,general,080)
  191. .in
  192. .bmp(mnubld.shg).n
  193. .n
  194. Click on the menu item you want help with.
  195. .un
  196. .end
  197. .com(=================================)
  198. .com( test command topic              )
  199. .com(=================================)
  200. .entc(testem,Test Command,The ,general,090)
  201. .in
  202. .bmp(mnutst.shg).n
  203. .n
  204. Click on the menu item you want help with.
  205. .un
  206. .end
  207. .com(=================================)
  208. .com( options commands TOC topic      )
  209. .com(=================================)
  210. .entc(options,Options Commands,The ,general,100)
  211. .in
  212. .bmp(mnuopt.shg).n
  213. .n
  214. Click on the menu item you want help with.
  215. .un
  216. .end
  217. .com(=================================)
  218. .com( help commands TOC topic         )
  219. .com(=================================)
  220. .entc(help,Help Commands,The ,general,110)
  221. .in
  222. .bmp(mnuhlp.shg).n
  223. .n
  224. Click on the menu item you want help with.
  225. .un
  226. .end
  227. .com(=================================)
  228. .com( open macro file topic           )
  229. .com(=================================)
  230. .entc(open,Open Macro File, ,general,120)
  231. Open an existing .p1(macro) file, or create a new macro file to be
  232.  edited (.b(File | Open Macro File) menu item).  A check will be made
  233.  for a corresponding .p1(project) file.  If a project file exists,
  234.  then the .b(Edit | Project File) menu item will be enabled.  If a
  235.  project file does not exist, then the .b(Build | Project File) menu
  236.  item will be enabled.  The HelpGen .p(titlebar,title bar) is
  237.  updated to reflect the current macro file name.
  238. .s
  239. .bmpl(openrtf.bmp)You may also select this menu item with the
  240.  .p1(toolbar) Open Macro File button.
  241. .end
  242. .com(=================================)
  243. .com( close macro file topic          )
  244. .com(=================================)
  245. .entc(close,Close Macro File, ,general,130)
  246. The Close command closes all files and disables all HelpGen menu
  247.  items that are associated with open files
  248.  (.b(File | Close Macro File) menu item).  The HelpGen
  249.  .p(titlebar,title bar) is updated to show that no .p1(macro) file
  250.  is currently open.
  251. .s
  252. .bmpl(closertf.bmp)You may also select this menu item with the
  253.  .p1(toolbar) Close Macro File button.
  254. .end
  255. .com(=================================)
  256. .com( print macro file topic          )
  257. .com(=================================)
  258. .entc(print,Print Macro File, ,general,140)
  259. The Print command will print the current .p1(macro) file on any
  260.  printer (.b(File | Print Macro File) menu item).  You will be asked
  261.  to select the proper printer before any printing takes place.
  262. .s
  263. .bmpl(printrtf.bmp)You may also select this menu item with the
  264.  .p1(toolbar) Print Macro File button.
  265. .end
  266. .com(=================================)
  267. .com( exit topic                      )
  268. .com(=================================)
  269. .entc(exit,Exit to Program Manager, ,general,150)
  270. The Exit command closes all open files and shuts down the HelpGen
  271.  program (.b(File | Exit) menu item).
  272. .end
  273. .com(=================================)
  274. .com( edit macro file topic           )
  275. .com(=================================)
  276. .entc(editmac,Edit Macro File, ,general,160)
  277. The .b(Edit | Macro File) command executes a text editor and allows
  278.  you to make changes to the current .p1(macro) file.  The default
  279.  text editor is NOTEPAD.EXE.  The default editor may be changed using
  280.  the .b(Options | Directories) menu item.
  281. .s
  282. .bmpl(edmacrtf.bmp)You may also select this menu item with the
  283.  .p1(toolbar) Edit Macro File button.
  284. .s
  285. .box
  286. .b(NOTE:) When HelpGen invokes the text editor, and for some reason
  287.  the editor can't be executed, HelpGen will notify you by displaying
  288.  an error message.  To possibly correct your problem, make sure that
  289.  the text editor is correctly chosen in HelpGen's
  290.  .b(Options | Directories) menu item.
  291. .bend
  292. .end
  293. .com(=================================)
  294. .com( edit project file topic         )
  295. .com(=================================)
  296. .entc(edithpj,Edit Project File, ,general,170)
  297. The .b(Edit | Project File) menu item executes a text editor and
  298.  allows you to make changes to the current .p1(project) file.  The
  299.  default text editor is NOTEPAD.EXE.  The default editor may be
  300.  changed using the .b(Options | Directories) menu item.
  301. .s
  302. .bmpl(edhpjrtf.bmp)You may also select this menu item with the
  303.  .p1(toolbar) Edit Project File button.
  304. .s
  305. .box
  306. .b(NOTE:) When HelpGen invokes the text editor, and for some reason
  307.  the editor can't execute, HelpGen will notify you by displaying an
  308.  error message.  To possibly correct your problem, make sure that
  309.  the text editor is correctly chosen in HelpGen's
  310.  .b(Options | Directories) menu item.
  311. .bend
  312. .end
  313. .com(=================================)
  314. .com( edit bitmap file topic          )
  315. .com(=================================)
  316. .entc(editbit,Edit Bitmap, ,general,180)
  317. The .b(Edit | Bitmap) menu item executes a paint program and allows
  318.  you to make changes to a bitmap.  The default paint program is
  319.  PBRUSH.EXE.  The default program may be changed using the
  320.  .b(Options | Directories) menu item.
  321. .s
  322. .box
  323. .b(NOTE:) When HelpGen invokes the paint program, and for some reason
  324.  the program can't execute, HelpGen will notify you by displaying an
  325.  error message.  To possibly correct your problem, make sure that
  326.  the paint program is correctly chosen in HelpGen's
  327.  .b(Options | Directories) menu item.
  328. .bend
  329. .end
  330. .com(=================================)
  331. .com( edit hotspot file topic         )
  332. .com(=================================)
  333. .entc(edithot,Edit Hotspot, ,general,190)
  334. The .b(Edit | Hotspot) menu item executes the Microsoft hotspot
  335.  editor and allows you to mark hotspots on a bitmap.  The
  336.  default hotspot editor is SHED.EXE.  The default editor may be
  337.  changed using the .b(Options | Directories) menu item.
  338. .s
  339. .box
  340. .b(NOTE:) When HelpGen invokes the hotspot editor, and for some reason
  341.  the editor can't execute, HelpGen will notify you by displaying an
  342.  error message.  To possibly correct your problem, make sure that
  343.  the text editor is correctly chosen in HelpGen's
  344.  .b(Options | Directories) menu item.
  345. .bend
  346. .end
  347. .com(=================================)
  348. .com( build project file topic        )
  349. .com(=================================)
  350. .entc(genhpj,Build Project File, ,general,200)
  351. If you don't yet have a .p1(project) file for your current
  352.  .p1(macro) file, this menu item will be enabled
  353.  (.b(Build | Project File) menu item).  It will create a project file
  354.  for you, based on the entries contained in the .b(Options) menu.
  355.  You may then make any changes to this file using the
  356.  .b(Edit | Project File) menu item.  The project file will have the
  357.  same filename as the macro file, with an extension of .HPJ.
  358. .s
  359. .bmpl(buhpjrtf.bmp)You may also select this menu item with the
  360.  .p1(toolbar) Build Project File button.
  361. .end
  362. .com(=================================)
  363. .com( build RTF file topic            )
  364. .com(=================================)
  365. .entc(genrtf,Build RTF File Only, ,general,210)
  366. The .b(Build | RTF File Only) menu item uses the current .p1(macro) file
  367.  to build a Rich Text Format (.p1(RTF)) file of the same name.  The
  368.  RTF file is used as an input file for the .p(hlpcmplr,help compiler)..n
  369. .end
  370. .com(=================================)
  371. .com( build HLP file topic            )
  372. .com(=================================)
  373. .entc(genhlp,Build HLP File Only, ,general,220)
  374. The .b(Build | HLP File) menu item uses the current .p1(project)
  375.  file and the .p1(RTF) file created by HelpGen to create a Microsoft
  376.  Help File (HLP).  It does this by invoking the Microsoft (or other)
  377.  help compiler.  The default help compiler is HC31.EXE.  You may
  378.  change the default help compiler by using the
  379.  .b(Options | Directories) menu item.
  380. .s
  381. .box
  382. .b(NOTE:) When HelpGen invokes the help compiler, and for some
  383.  reason the compiler can't execute, HelpGen will notify you by
  384.  displaying an error message.  To possibly correct your problem, make
  385.  sure that the proper help compiler is correctly chosen in HelpGen's
  386.  .b(Options | Directories) menu item.
  387. .bend
  388. .end
  389. .com(=================================)
  390. .com( build HLP from MAC topic        )
  391. .com(=================================)
  392. .entc(genmachlp,Build HLP from MAC, ,general,225)
  393. The .b(Build | HLP from MAC) menu item uses .p1(macro) file to create
  394.  an .p1(RTF) file. It then uses the current .p1(project)
  395.  file and the .p1(RTF) file to create a Microsoft
  396.  Help File (HLP).  It does this by invoking the Microsoft (or other)
  397.  help compiler.  The default help compiler is HC31.EXE.  You may
  398.  change the default help compiler by using the
  399.  .b(Options | Directories) menu item.
  400. .s
  401. .bmpl(buhlprtf.bmp)You may also select this menu item with the
  402.  .p1(toolbar) Build HLP from MAC button.
  403. .s
  404. .box
  405. .b(NOTE:) When HelpGen invokes the help compiler, and for some
  406.  reason the compiler can't execute, HelpGen will notify you by
  407.  displaying an error message.  To possibly correct your problem, make
  408.  sure that the proper help compiler is correctly chosen in HelpGen's
  409.  .b(Options | Directories) menu item.
  410. .bend
  411. .end
  412. .com(=================================)
  413. .com( build HTML file topic           )
  414. .com(=================================)
  415. .entc(genhtml,Build HTML File, ,general,227)
  416. The .b(Build | HTML File) menu item uses the current
  417.  .p1(RTF) file created by HelpGen to create a World
  418.  Wide Web hypertext markup language (.p1(HTML)) file. The
  419.  created file has a .HTM file extension.
  420. .end
  421. .com(=================================)
  422. .com( test command topic              )
  423. .com(=================================)
  424. .entc(testhlp,Test HLP file, ,general,228)
  425. The .b(Test HLP file) menu item allows you to test the
  426.  help file that you have just generated.  It will
  427.  only be enabled after you have generated a help file.
  428. .s
  429. .bmpl(testrtf.bmp)You may also select this menu item with the
  430.  .p1(toolbar) Test Help File button.
  431. .end
  432. .com(=================================)
  433. .com( test command topic              )
  434. .com(=================================)
  435. .entc(testhtml,Test HTML file, ,general,228)
  436. The .b(Test HTML file) menu item allows you to test the
  437.  hypertext markup language file that you have just generated.
  438.  It does this by invoking the Web browser you have designated
  439.  in the .b(Options | Directories) dialog.
  440. .end
  441. .com(=================================)
  442. .com( directories options topic       )
  443. .com(=================================)
  444. .entc(optdir,Directories,Set ,general,230)
  445. The .b(Options | Directories) menu item allows you to select the
  446.  .p(hlpcmplr,help compiler) and text editor that HelpGen uses when
  447.  building a help file or editing text.  You can also select a Paint 
  448.  program, a Hotspot Editor and a Web browser for HelpGen to use. 
  449.  The entries that you make are saved in HelpGen's .INI file and 
  450.  will be used each time you execute HelpGen.
  451. .end
  452. .com(=================================)
  453. .com( project file options topic      )
  454. .com(=================================)
  455. .entc(opthpj,Project File Options,Set ,general,240)
  456. The .b(Options | Project File) menu item allows you to specify the
  457.  options that will be installed in a .p1(project) file that is
  458.  created by HelpGen.  Some of these options are saved in HelpGen's
  459.  .INI file, so they may be used in subsequent executions of HelpGen.
  460.  Specifically, the Compression type, Warnings, Report status,
  461.  Copyright notice and Error Log are all saved in the .INI file..n
  462. .n
  463. .i(Title).n
  464. The Title specifies the string that is placed on the Help File's
  465.  .p(titlebar,title bar) when the help file is executed..n
  466. .n
  467. .i(Copyright).n
  468. The Copyright specifies the string that is placed inside of the help
  469.  file's About box.  This box is activated by executing the help file
  470.  and selecting .b(Help | About Help)..n
  471. .n
  472. .i(Error Log).n
  473. The Error Log is the file that the .p(hlpcmplr,help compiler) uses
  474.  to write error messages to.  If you have errors during a help
  475.  compilation, look at this file to see what the errors were..n
  476. .n
  477. .i(Icon File).n
  478. The Icon File entry specifies the icon that will be used when the
  479.  help file is minimized.  This entry will override the default
  480.  question mark icon..n
  481. .n
  482. .i(Bitmap Root).n
  483. The Bitmap Root specifies the directory that is used to store bitmap
  484.  files, if they are not in the current directory..n
  485. .n
  486. .i(Compression).n
  487. The Compression option specifies what type of compression is used
  488.  when building the help file.  .b(0) specifies no compression,
  489.  .b(Medium) specifies 40% compression and .b(High) specifies 50%
  490.  compression..n
  491. .n
  492. .i(Warnings).n
  493. The Warnings option sets the level of error messages that the help
  494.  compiler will display during compilation. .b(Some) means only the
  495.  most severe messages will be displayed, .b(Many) means a medium
  496.  amount of error messages will be displayed, and .(All) means display
  497.  all messages..n
  498. .n
  499. .i(Report).n
  500. The Report option determines the type of error messages that are
  501.  displayed during help file compilation.
  502. .end
  503. .com(=================================)
  504. .com( help contents topic             )
  505. .com(=================================)
  506. .entc(hlpcon,Help Contents, ,general,250)
  507. The .b(Help | Contents) menu item executes the help file you are
  508.  currently reading.
  509. .s
  510. .bmpl(helprtf.bmp)You may also select this menu item with the
  511.  .p1(toolbar) Help Contents button.
  512. .end
  513. .com(=================================)
  514. .com( help using topic                )
  515. .com(=================================)
  516. .entc(hlpsrch,Search for Help on, ,general,251)
  517. The .b(Help | Search for Help on) menu item invokes the
  518.  standard Search dialog for the HelpGen Help file.
  519. .end
  520. .com(=================================)
  521. .com( help using topic                )
  522. .com(=================================)
  523. .entc(hlpusing,Help on Help, ,general,252)
  524. The .b(Help | Help on Help) menu item executes a
  525.  standard help file that explains how to use Help files.
  526. .end
  527. .com(=================================)
  528. .com( register helpgen topic          )
  529. .com(=================================)
  530. .entc(register,Register HelpGen, ,general,260)
  531. The .b(Help | Register HelpGen) menu item  allows you to fill out
  532.  entries and print a registration form.  The entries will be printed
  533.  one line after the other.  If any entry is missing, that entry will
  534.  not be printed.
  535. .end
  536. .com(=================================)
  537. .com( about helpgen topic             )
  538. .com(=================================)
  539. .entc(about,About HelpGen, ,general,270)
  540. The .b(Help | About HelpGen) menu item provides information about
  541.  the current version of the HelpGen program.
  542. .end
  543. .com(=================================)
  544. .com( language basics topic           )
  545. .com(=================================)
  546. .entc(langbas,Language Basics, ,general,280)
  547. HelpGen Macro Files consist of distinct blocks of text. These blocks
  548.  are marked by HelpGen .p(macro,macros).  The first block is the
  549.  \'2estart/\'2eend/\'2eend_file block:.n
  550. .n
  551. .[
  552. \li720
  553. \'2estart(......).n
  554. \tab Table of Contents stuff here.....n
  555. \'2eend.n.n
  556. \tab Rest of macro file goes here.....n.n
  557. \'2eend_file.n
  558. .]
  559. .n
  560. The rest of the macro file is broken up into \'2eent/\'2eend and
  561.  \'2epent/\'2eend blocks:.n
  562. .n
  563. .[
  564. \li720
  565. \'2estart(......).n
  566. \tab Table of Contents stuff here.....n
  567. \'2eend.n.n
  568. \'2eent(.....).n
  569. \tab Topic stuff here.....n
  570. \'2eend.n.n
  571. \'2eent(.....).n
  572. \tab Topic stuff here.....n
  573. \'2eend.n.n
  574. \'2eent(.....).n
  575. \tab Topic stuff here.....n
  576. \'2eend.n.n
  577. \'2epent(.....).n
  578. \tab Popup stuff here.....n
  579. \'2eend.n.n
  580. \'2epent(.....).n
  581. \tab Popup stuff here.....n
  582. \'2eend.n.n
  583. \'2eend_file.n
  584. .]
  585. .n
  586. Note the use of white space to separate the various blocks.  You may
  587.  also separate the blocks with remarks:.n
  588. .n
  589. .[
  590. \li720
  591. \'2erem(===== Beginning of topic 1 =====).n
  592. \'2eent(.....).n
  593. \tab Topic stuff here.....n
  594. \'2eend.n
  595. \'2erem(===== Beginning of topic 2 =====).n
  596. \'2eent(.....).n
  597. \tab Topic stuff here.....n
  598. \'2eend.n
  599. .]
  600. .n
  601. In order to display each of these blocks, you need to have jumps
  602.  (\'2ej or \'2ej1 for the \'2eent/\'2eend blocks and \'2ep or \'2ep1
  603.  for the \'2epent/\'2eend blocks) somewhere in your macro file.
  604.  Since the help file begins at the Table of Contents, there should
  605.  definitely be some jumps in that .p1(topic)..n
  606. .n
  607. All the rest of the HelpGen macros are basically window dressing for
  608.  the topic blocks.  See the various macro commands for examples of
  609.  how to use them..n
  610. .n
  611. HelpGen generates an RTF file that specifies nine text fonts:.n.n
  612. .in
  613. font 0 - Arial (default for topic headers).n
  614. font 1 - Times New Roman (default for normal text in a topic).n
  615. font 2 - Courier (default for \'2e[ and \'2e] text).n
  616. font 3 - MS Sans Serif.n
  617. font 4 - Roman.n
  618. font 5 - MS Serif.n
  619. font 6 - Symbol.n
  620. font 7 - Helv.n
  621. font 8 - Arial MT.n
  622. .un
  623. Fonts 0, 1 and 8 are True Type fonts..n
  624. .end
  625. .com(=================================)
  626. .com( macro commands TOC topic        )
  627. .com(=================================)
  628. .entc(maccmd,Macro Language Commands, ,general,290)
  629. .in
  630. .bi(Topic Macros)
  631. ##.j(cmdstr,\'2estart)
  632. ##.j(cmdstrc,\'2estartc)
  633. ##.j(cmdent,\'2eent)
  634. ##.j(cmdentc,\'2eentc)
  635. ##.j(cmdpent,\'2epent)
  636. ##.j(cmdpentc,\'2epentc)
  637. ##.j(cmdend,\'2eend).n.n
  638. .bi(Hypertext Navigation Macros)
  639. ##.j(cmdj,\'2ej)
  640. ##.j(cmdj1,\'2ej1)
  641. ##.j(cmdp,\'2ep)
  642. ##.j(cmdp1,\'2ep1)
  643. ##.j(cmdbj,\'2ebj)
  644. ##.j(cmdbp,\'2ebp)
  645. ##.j(cmdfj,\'2efj)
  646. ##.j(cmdbfj,\'2ebjf).n.n
  647. .bi(Keyword Macros)
  648. ##.j(cmdtop,\'2etop).n.n
  649. .bi(Graphics Display Macros)
  650. ##.j(cmdbmp,\'2ebmp)
  651. ##.j(cmdbmpl,\'2ebmpl)
  652. ##.j(cmdbmpr,\'2ebmpr).n.n
  653. .bi(Box Macros)
  654. ##.j(cmdbox,\'2ebox)
  655. ##.j(cmdbend,\'2ebend).n.n
  656. .bi(Documentation Macros)
  657. ##.j(cmdrem,\'2erem)
  658. ##.j(cmdcom,\'2ecom).n.n
  659. .bi(Text Formatting Macros)
  660. ##.j(cmdin,\'2ein)
  661. ##.j(cmdun,\'2eun)
  662. ##.j(cmdpp,\'23\'23)
  663. ##.j(cmdbi,\'2ebi)
  664. ##.j(cmdbu,\'2ebu)
  665. ##.j(cmdiu,\'2eiu)
  666. ##.j(cmdpb,\'23b)
  667. ##.j(cmdpn,\'23n)
  668. ##.j(cmdb,\'2eb)
  669. ##.j(cmdi,\'2ei)
  670. ##.j(cmdob,\'2e[)
  671. ##.j(cmdcb,\'2e])
  672. ##.j(cmdn,\'2en)
  673. ##.j(cmds,\'2es)
  674. ##.j(cmdc,\'2ec).n.n
  675. .bi(Help Macro Access Macros)
  676. ##.j(cmdmacro,\'2emacro)
  677. ##.j(cmdbmacro,\'2e\'62macro).n.n
  678. .bi(Miscellaneous Macros)
  679. ##.j(cmdbf,\'2ebegin_file)
  680. ##.j(cmdef,\'2eend_file)
  681. .un
  682. .end
  683. .end_file
  684.